Remove a department
This request is used to delete a department and all subordinate (child) departments.
The deleted department and subordinate departments:
- can only contain archived employees;
- they should not have roles attached to them — secretaries and department managers.
Otherwise, the deletion will not occur, and the request will return an error with code 400.
When deleted, the department can't be found in the account profile.
Request syntax
POST https://b2b-api.go.yandex.ru/integration/2.0/departments/archive?department_id={department ID}
Request headers
Authorization: Bearer <OAuth-token>
OAuth access token. The steps to get a token are described in Getting started.
X-YaTaxi-Selected-Corp-Client-Id— client ID from the account. Required if multiple clients are available using the token.
Request parameters
The request contains the following required parameter:
department_id: department ID.
Response field description
The response contains the following fields:
| Field | Description | Format |
|---|---|---|
deleted_ids |
IDs of all deleted departments. | String |
Request example
POST https://b2b-api.go.yandex.ru/integration/2.0/departments/archive?department_id=87e8...646c
...
Authorization: Bearer <OAuth-token>
X-YaTaxi-Selected-Corp-Client-Id: <client-id>
Response example
An example response to this request looks like this:
{
"deleted_ids": ["87e8...646c", "2f53...4bca"]
}
Response codes
The response to this request may contain the following standard HTTP codes:
200: Request completed successfully.400: An unknown parameter or a parameter with an invalid value was passed in the request.401: The OAuth token is incorrect.403: The client doesn't have sufficient rights to run this request.- SELECT_CLIENT_HEADER_REQUIRED: the request did not pass the header
X-YaTaxi-Selected-Corp-Client-Id(returned if more than one client is available for the token). - SELECTED_CLIENT_ACCESS_DENIED: the header
X-YaTaxi-Selected-Corp-Client-Idcontains the client's ID, which this login does not have access to.
- SELECT_CLIENT_HEADER_REQUIRED: the request did not pass the header
404: The requested record wasn't found.